<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<META http-equiv="Content-Type" content="text/html; charset=UTF-8">
<link rel="stylesheet" href="../../../../style.css" type="text/css" media="screen">
<link rel="stylesheet" href="../../../../print.css" type="text/css" media="print">
<meta content="BrowserLocationUtil,com.developmentarc.core.utils.BrowserLocationUtil,fragment,parameters,path,port,protocal,query,serverName,url" name="keywords">
<title>com.developmentarc.core.utils.BrowserLocationUtil</title>
</head>
<body>
<script type="text/javascript" language="javascript" src="../../../../asdoc.js"></script><script type="text/javascript" language="javascript" src="../../../../cookies.js"></script><script type="text/javascript" language="javascript">
<!--
				asdocTitle = 'BrowserLocationUtil - DevelopmentArc Core API Documentation';
				var baseRef = '../../../../';
				window.onload = configPage;
			--></script>
<table style="display:none" id="titleTable" cellspacing="0" cellpadding="0" class="titleTable">
<tr>
<td align="left" class="titleTableTitle">DevelopmentArc Core API</td><td align="right" class="titleTableTopNav"><a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../package-summary.html">All&nbsp;Packages</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../all-classes.html')" href="../../../../class-summary.html">All&nbsp;Classes</a>&nbsp;|&nbsp;<a onclick="loadClassListFrame('../../../../index-list.html')" href="../../../../all-index-A.html">Index</a>&nbsp;|&nbsp;<a href="../../../../index.html?com/developmentarc/framework/utils/BrowserLocationUtil.html&amp;com/developmentarc/framework/utils/class-list.html" id="framesLink1">Frames</a><a onclick="parent.location=document.location" href="" style="display:none" id="noFramesLink1">No&nbsp;Frames</a></td><td rowspan="3" align="right" class="titleTableLogo"><img alt="Adobe Logo" title="Adobe Logo" class="logoImage" src="../../../../images/logo.jpg"></td>
</tr>
<tr class="titleTableRow2">
<td align="left" id="subTitle" class="titleTableSubTitle">Class&nbsp;BrowserLocationUtil</td><td align="right" id="subNav" class="titleTableSubNav"><a href="#propertySummary">Properties</a></td>
</tr>
<tr class="titleTableRow3">
<td colspan="2">&nbsp;</td>
</tr>
</table>
<script type="text/javascript" language="javascript">
<!--
if (!isEclipse() || window.name != ECLIPSE_FRAME_NAME) {titleBar_setSubTitle("Class BrowserLocationUtil"); titleBar_setSubNav(false,true,false,false,false,false,false,false,false,false,false,false,false,false);}
--></script>
<div class="MainContent">
<table cellspacing="0" cellpadding="0" class="classHeaderTable">
<tr>
<td class="classHeaderTableLabel">Package</td><td><a onclick="javascript:loadClassListFrame('class-list.html')" href="package-detail.html">com.developmentarc.core.utils</a></td>
</tr>
<tr>
<td class="classHeaderTableLabel">Class</td><td class="classSignature">public class BrowserLocationUtil</td>
</tr>
</table>
<p></p>
  Class is a utility class that provides a mix of functionaltity from Flex's BrowserManager and URLUtil classes.  
  The goal of the class is to give an application a mechinism to query the browser's current url (like one can with BrowserManager),
  but without leveraging the history managment system that flex provides. This allows application that do not include history.js a 
  way to retreive the current runtime url and parse all the various parts pieces. Below is a breakdown of a typical url and all
  the properties one can access.
  <br />
  <div class='listing'><pre>
     https://google.com:8080/path/is/here/?param1=value1#page2
     \___/   \________/ \__/\____________/ \___________/ \__/
       |        |        |       |               |        |
       |   server name  port    path           query   fragment    
    protocal 
  </pre></div>              
  <p></p>
<br>
<hr>
</div>
<a name="propertySummary"></a>
<div class="summarySection">
<div class="summaryTableTitle">Public Properties</div>
<table id="summaryTableProperty" class="summaryTable " cellpadding="3" cellspacing="0">
<tr>
<th>&nbsp;</th><th colspan="2">Property</th><th class="summaryTableOwnerCol">Defined&nbsp;by</th>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#fragment">fragment</a> : String<div class="summaryTableDescription">[static][read-only]
   Method returns the fragment portion of the url which is all data after the "#".</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#parameters">parameters</a> : Object<div class="summaryTableDescription">[static][read-only]
   Method breaks down the query string of the current url
   passing back a generic object with each key/value pair.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#path">path</a> : String<div class="summaryTableDescription">[static][read-only]
   Method returns the path portion of the current url
   br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns /path/is/here/
   
   </div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#port">port</a> : uint<div class="summaryTableDescription">[static][read-only]
   Method returns the port number specificed in the current url.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#protocal">protocal</a> : String<div class="summaryTableDescription">[static][read-only]
   Method encapsulates the URLUtil's getProtocal method returning the protocal of the current url.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#query">query</a> : String<div class="summaryTableDescription">[static][read-only]
   Method return the current query string of the url, which is the protion of the url
   after the servername and/or port and before the framgment of the url.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#serverName">serverName</a> : String<div class="summaryTableDescription">[static][read-only]
   Method returns the server name in the current url of the application.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
<tr class="">
<td class="summaryTablePaddingCol">&nbsp;</td><td class="summaryTableInheritanceCol">&nbsp;</td><td class="summaryTableSignatureCol"><a class="signatureLink" href="#url">url</a> : String<div class="summaryTableDescription">[static][read-only]
   Method returns the current full url in the application.</div>
</td><td class="summaryTableOwnerCol">BrowserLocationUtil</td>
</tr>
</table>
</div>
<script type="text/javascript" language="javascript">
<!--
showHideInherited();
--></script>
<div class="MainContent">
<a name="propertyDetail"></a>
<div class="detailSectionHeader">Property detail</div>
<a name="fragment"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">fragment</td><td class="detailHeaderType">property</td>
</tr>
</table>
<div class="detailBody">
<code>fragment:String</code>&nbsp;&nbsp;[read-only]<p>
   Method returns the fragment portion of the url which is all data after the "#".
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns page2
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get fragment():String</code>
<br>
</div>
<a name="parameters"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">parameters</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>parameters:Object</code>&nbsp;&nbsp;[read-only]<p>
   Method breaks down the query string of the current url
   passing back a generic object with each key/value pair.
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns {param1:'value1'}
   <br />
   <b>Note:</b>  This method utilizes the mx.utils.URLUtil.stringToObject() method, which 
   overrides parameters of the same name with the last value found in the string.
   <br />
   Example: Example: http://google.com:8080/path/is/here/?param1=value1&param1=value2#page2 returns {param1:'value2'} 
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get parameters():Object</code>
<br>
</div>
<a name="path"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">path</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>path:String</code>&nbsp;&nbsp;[read-only]<p>
   Method returns the path portion of the current url
   br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns /path/is/here/
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get path():String</code>
<br>
</div>
<a name="port"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">port</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>port:uint</code>&nbsp;&nbsp;[read-only]<p>
   Method returns the port number specificed in the current url. If no port is provided 0 will be returned.
   This method utilizes the Flex URLUtil.getPort() method. See that method for more details.
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns 8080
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get port():uint</code>
<br>
</div>
<a name="protocal"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">protocal</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>protocal:String</code>&nbsp;&nbsp;[read-only]<p>
   Method encapsulates the URLUtil's getProtocal method returning the protocal of the current url.
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns  http
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get protocal():String</code>
<br>
</div>
<a name="query"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">query</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>query:String</code>&nbsp;&nbsp;[read-only]<p>
   Method return the current query string of the url, which is the protion of the url
   after the servername and/or port and before the framgment of the url.
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns param1=value1
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get query():String</code>
<br>
</div>
<a name="serverName"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">serverName</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>serverName:String</code>&nbsp;&nbsp;[read-only]<p>
   Method returns the server name in the current url of the application.
   <br/>
   Example: http://google.com:8080/path/is/here/?param1=value1#page2 returns google.com
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get serverName():String</code>
<br>
</div>
<a name="url"></a>
<table cellspacing="0" cellpadding="0" class="detailHeader">
<tr>
<td class="detailHeaderName">url</td><td class="detailHeaderType">property</td><td class="detailHeaderRule">&nbsp;</td>
</tr>
</table>
<div class="detailBody">
<code>url:String</code>&nbsp;&nbsp;[read-only]<p>
   Method returns the current full url in the application.
   The functionality of this method relies on ExternalInterface to call
   'window.location.href.toString' to gather the current url.
   
   </p><span class="label">Implementation</span>
<br>
<code>&nbsp;&nbsp;&nbsp;&nbsp;public static function get url():String</code>
<br>
</div>
<br>
<br>
<hr>
<br>
<p></p>
<center class="copyright"> 
</center>
</div>
</body>
</html>
<!-- -->
